Contents
- StateT <S, M, A> (Func<S, K<M, (A Value, S State)>> runState)
- Pure (A value)
- Modify (Func<S, S> f)
- ModifyM (Func<S, K<M, S>> f)
- Put (S value)
- State (A value, S state)
- State ((A value, S state) ma)
- Get
- Gets (Func<S, A> f)
- GetsM (Func<S, K<M, A>> f)
- Lift (Pure<A> monad)
- Lift (K<M, A> monad)
- Lift (Func<A> f)
- LiftIO (IO<A> ma)
- MapT <M1, B> (Func<K<M, (A Value, S State)>, K<M1, (B Value, S State)>> f)
- MapM <B> (Func<K<M, A>, K<M, B>> f)
- Map <B> (Func<A, B> f)
- Select <B> (Func<A, B> f)
- Bind <B> (Func<A, K<StateT<S, M>, B>> f)
- Bind <B> (Func<A, StateT<S, M, B>> f)
- Bind <B> (Func<A, Gets<S, B>> f)
- Bind (Func<A, Put<S>> f)
- Bind (Func<A, Modify<S>> f)
- Bind <B> (Func<A, IO<B>> f)
- SelectMany <B, C> (Func<A, K<StateT<S, M>, B>> bind, Func<A, B, C> project)
- SelectMany <B, C> (Func<A, StateT<S, M, B>> bind, Func<A, B, C> project)
- SelectMany <B, C> (Func<A, K<M, B>> bind, Func<A, B, C> project)
- SelectMany <B, C> (Func<A, Pure<B>> bind, Func<A, B, C> project)
- SelectMany <C> (Func<A, Put<S>> bind, Func<A, Unit, C> project)
- SelectMany <B, C> (Func<A, Gets<S, B>> bind, Func<A, B, C> project)
- SelectMany <C> (Func<A, Modify<S>> bind, Func<A, Unit, C> project)
- SelectMany <B, C> (Func<A, IO<B>> bind, Func<A, B, C> project)
- | (StateT<S, M, A> ma, StateT<S, M, A> mb)
- | (StateT<S, M, A> ma, Pure<A> mb)
- | (Pure<A> ma, StateT<S, M, A>mb)
- | (IO<A> ma, StateT<S, M, A> mb)
- Run (S state)
- StateTExtensions
- As <Env, M, A> (this K<StateT<Env, M>, A> ma)
- Flatten <Env, M, A> (this StateT<Env, M, StateT<Env, M, A>> mma)
- SelectMany <Env, M, A, B, C> ( this K<M, A> ma, Func<A, K<StateT<Env, M>, B>> bind, Func<A, B, C> project)
- SelectMany <Env, M, A, B, C> ( this K<M, A> ma, Func<A, StateT<Env, M, B>> bind, Func<A, B, C> project)
- StateT <S>
- StateT <S, M>
- StateT
- bind <S, M, A, B> (StateT<S, M, A> ma, Func<A, StateT<S, M, B>> f)
- map <S, M, A, B> (Func<A, B> f, StateT<S, M, A> ma)
- Pure <S, M, A> (A value)
- apply <S, M, A, B> (StateT<S, M, Func<A, B>> mf, StateT<S, M, A> ma)
- action <S, M, A, B> (StateT<S, M, A> ma, StateT<S, M, B> mb)
- lift <S, M, A> (K<M, A> ma)
- liftIO <S, M, A> (IO<A> effect)
- get <M, S> ()
- gets <M, S, A> (Func<S, A> f)
- getsM <M, S, A> (Func<S, K<M, A>> f)
- put <M, S> (S state)
- modify <M, S> (Func<S, S> f)
- modifyM <M, S> (Func<S, K<M, S>> f)
- StateT <S, M>
record StateT <S, M, A> (Func<S, K<M, (A Value, S State)>> runState) Source #
StateT monad transformer, which adds a modifiable state to a given monad.
Parameters
| type | S | State type |
| type | M | Given monad trait |
| type | A | Bound value type |
| param | runState | Transducer that represents the transformer operation |
Properties
Methods
method StateT<S, M, A> Pure (A value) Source #
Lift a pure value into the monad-transformer
Parameters
| param | value | Value to lift |
| returns |
| |
method StateT<S, M, Unit> Modify (Func<S, S> f) Source #
Extracts the state value, maps it, and then puts it back into the monadic state.
Parameters
| param | f | State mapping function |
| returns |
| |
method StateT<S, M, Unit> ModifyM (Func<S, K<M, S>> f) Source #
Extracts the state value, maps it, and then puts it back into the monadic state.
Parameters
| param | f | State mapping function |
| returns |
| |
method StateT<S, M, Unit> Put (S value) Source #
Writes the value into the monadic state
Parameters
| returns |
| |
method StateT<S, M, A> State (A value, S state) Source #
Writes a value and state into the monad
Parameters
| returns |
| |
method StateT<S, M, A> State ((A value, S state) ma) Source #
Writes a value and state into the monad
Parameters
| returns |
| |
method StateT<S, M, A> Gets (Func<S, A> f) Source #
Extracts the state value and maps it to the bound value
Parameters
| param | f | State mapping function |
| returns |
| |
method StateT<S, M, A> GetsM (Func<S, K<M, A>> f) Source #
Extracts the state value and maps it to the bound value
Parameters
| param | f | State mapping function |
| returns |
| |
method StateT<S, M, A> Lift (Pure<A> monad) Source #
Lifts a given monad into the transformer
Parameters
| param | monad | Monad to lift |
| returns |
| |
method StateT<S, M, A> Lift (K<M, A> monad) Source #
Lifts a given monad into the transformer
Parameters
| param | monad | Monad to lift |
| returns |
| |
method StateT<S, M, A> Lift (Func<A> f) Source #
Lifts a function into the transformer
Parameters
| param | f | Function to lift |
| returns |
| |
method StateT<S, M, A> LiftIO (IO<A> ma) Source #
Lifts a an IO monad into the monad
NOTE: If the IO monad isn't the innermost monad of the transformer stack then this will throw an exception.
Parameters
| param | ma | IO monad to lift |
| returns |
| |
method StateT<S, M1, B> MapT <M1, B> (Func<K<M, (A Value, S State)>, K<M1, (B Value, S State)>> f) Source #
Maps the given monad
Parameters
| type | M1 | Trait of the monad to map to |
| param | f | Mapping function |
| returns |
| |
method StateT<S, M, B> MapM <B> (Func<K<M, A>, K<M, B>> f) Source #
Maps the given monad
Parameters
| param | f | Mapping function |
| returns |
| |
method StateT<S, M, B> Map <B> (Func<A, B> f) Source #
Maps the bound value
Parameters
| type | B | Target bound value type |
| param | f | Mapping function |
| returns |
| |
method StateT<S, M, B> Select <B> (Func<A, B> f) Source #
Maps the bound value
Parameters
| type | B | Target bound value type |
| param | f | Mapping transducer |
| returns |
| |
method StateT<S, M, B> Bind <B> (Func<A, K<StateT<S, M>, B>> f) Source #
Monad bind operation
Parameters
| type | B | Target bound value type |
| param | f | Mapping function |
| returns |
| |
method StateT<S, M, B> Bind <B> (Func<A, StateT<S, M, B>> f) Source #
Monad bind operation
Parameters
| type | B | Target bound value type |
| param | f | Mapping function |
| returns |
| |
method StateT<S, M, B> Bind <B> (Func<A, Gets<S, B>> f) Source #
Monad bind operation
Parameters
| type | B | Target bound value type |
| param | f | Mapping function |
| returns |
| |
method StateT<S, M, Unit> Bind (Func<A, Put<S>> f) Source #
Monad bind operation
Parameters
| type | B | Target bound value type |
| param | f | Mapping function |
| returns |
| |
method StateT<S, M, Unit> Bind (Func<A, Modify<S>> f) Source #
Monad bind operation
Parameters
| type | B | Target bound value type |
| param | f | Mapping function |
| returns |
| |
method StateT<S, M, B> Bind <B> (Func<A, IO<B>> f) Source #
Monad bind operation
Parameters
| type | B | Target bound value type |
| param | f | Mapping function |
| returns |
| |
method StateT<S, M, C> SelectMany <B, C> (Func<A, K<StateT<S, M>, B>> bind, Func<A, B, C> project) Source #
Monad bind operation
Parameters
| type | B | Intermediate bound value type |
| type | C | Target bound value type |
| param | bind | Monadic bind function |
| param | project | Projection function |
| returns |
| |
method StateT<S, M, C> SelectMany <B, C> (Func<A, StateT<S, M, B>> bind, Func<A, B, C> project) Source #
Monad bind operation
Parameters
| type | B | Intermediate bound value type |
| type | C | Target bound value type |
| param | bind | Monadic bind function |
| param | project | Projection function |
| returns |
| |
method StateT<S, M, C> SelectMany <B, C> (Func<A, K<M, B>> bind, Func<A, B, C> project) Source #
Monad bind operation
Parameters
| type | B | Intermediate bound value type |
| type | C | Target bound value type |
| param | bind | Monadic bind function |
| param | project | Projection function |
| returns |
| |
method StateT<S, M, C> SelectMany <B, C> (Func<A, Pure<B>> bind, Func<A, B, C> project) Source #
Monad bind operation
Parameters
| type | B | Intermediate bound value type |
| type | C | Target bound value type |
| param | bind | Monadic bind function |
| param | project | Projection function |
| returns |
| |
method StateT<S, M, C> SelectMany <C> (Func<A, Put<S>> bind, Func<A, Unit, C> project) Source #
Monad bind operation
Parameters
| type | B | Intermediate bound value type |
| type | C | Target bound value type |
| param | bind | Monadic bind function |
| param | project | Projection function |
| returns |
| |
method StateT<S, M, C> SelectMany <B, C> (Func<A, Gets<S, B>> bind, Func<A, B, C> project) Source #
Monad bind operation
Parameters
| type | B | Intermediate bound value type |
| type | C | Target bound value type |
| param | bind | Monadic bind function |
| param | project | Projection function |
| returns |
| |
method StateT<S, M, C> SelectMany <C> (Func<A, Modify<S>> bind, Func<A, Unit, C> project) Source #
Monad bind operation
Parameters
| type | B | Intermediate bound value type |
| type | C | Target bound value type |
| param | bind | Monadic bind function |
| param | project | Projection function |
| returns |
| |
method StateT<S, M, C> SelectMany <B, C> (Func<A, IO<B>> bind, Func<A, B, C> project) Source #
Monad bind operation
Parameters
| type | B | Intermediate bound value type |
| type | C | Target bound value type |
| param | bind | Monadic bind function |
| param | project | Projection function |
| returns |
| |
class StateTExtensions Source #
State monad extensions
Methods
method StateT<Env, M, A> As <Env, M, A> (this K<StateT<Env, M>, A> ma) Source #
method StateT<Env, M, A> Flatten <Env, M, A> (this StateT<Env, M, StateT<Env, M, A>> mma) Source #
Monadic join
method StateT<Env, M, C> SelectMany <Env, M, A, B, C> ( this K<M, A> ma, Func<A, K<StateT<Env, M>, B>> bind, Func<A, B, C> project) Source #
Monad bind operation
Parameters
| type | B | Intermediate bound value type |
| type | C | Target bound value type |
| param | bind | Monadic bind function |
| param | project | Projection function |
| returns |
| |
method StateT<Env, M, C> SelectMany <Env, M, A, B, C> ( this K<M, A> ma, Func<A, StateT<Env, M, B>> bind, Func<A, B, C> project) Source #
Monad bind operation
Parameters
| type | B | Intermediate bound value type |
| type | C | Target bound value type |
| param | bind | Monadic bind function |
| param | project | Projection function |
| returns |
| |
MonadStateT trait implementation for StateT
Parameters
| type | S | State environment type |
| type | M | Given monad trait |
MonadStateT trait implementation for StateT
Parameters
| type | S | State environment type |
| type | M | Given monad trait |
MonadStateT trait implementation for StateT
Parameters
| type | S | State environment type |
| type | M | Given monad trait |
Methods
method StateT<S, M, B> bind <S, M, A, B> (StateT<S, M, A> ma, Func<A, StateT<S, M, B>> f) Source #
method StateT<S, M, B> map <S, M, A, B> (Func<A, B> f, StateT<S, M, A> ma) Source #
method StateT<S, M, B> apply <S, M, A, B> (StateT<S, M, Func<A, B>> mf, StateT<S, M, A> ma) Source #
method StateT<S, M, B> action <S, M, A, B> (StateT<S, M, A> ma, StateT<S, M, B> mb) Source #
method StateT<S, M, A> liftIO <S, M, A> (IO<A> effect) Source #
Lifts a given monad into the transformer
Parameters
| param | effect | Monad to lift |
| returns |
| |
method StateT<S, M, A> gets <M, S, A> (Func<S, A> f) Source #
method StateT<S, M, A> getsM <M, S, A> (Func<S, K<M, A>> f) Source #